home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / PWAEF221.ZIP / EFLAG.DOC < prev    next >
Encoding:
Text File  |  1995-11-15  |  8.4 KB  |  168 lines
  1. +-----------------------------------------------------------------------------+
  2. | Enhanced Flag v2.21                                                         |
  3. | Written by Drew [PWA]                                                       |
  4. | Docs Last Updated 11-15-95                                                  |
  5. +-----------------------------------------------------------------------------+
  6.  
  7.  
  8. +-----------------------------------------------------------------------------+
  9. | 0. Table of Contents                                                        |
  10. +-----------------------------------------------------------------------------+
  11.     1. Introduction
  12.     2. Packaging
  13.     3. Installation
  14.     4. Configuration
  15.     5. General Notes
  16.     6. Supporting PPE's
  17.     7. Last Words
  18.  
  19.  
  20. +-----------------------------------------------------------------------------+
  21. | 1. Introduction                                                             |
  22. +-----------------------------------------------------------------------------+ 
  23.     See HISTORY.DOC for all changes.  Otherwise...
  24.  
  25.     Enhanced Flag is a PPE replacement for the "More?" prompt during a file
  26. listing.  It gives you an easier to method of flagging files for downloading,
  27. viewing, nuking, et. al. by using a lightbar and hotkey driven interface, in-
  28. cluding all of the arrow keys.
  29.  
  30.     Additionally, through the usage of configuration files, EFLAG can spawn
  31. custom external commands (other PPE's) in addition to or replacing any or all
  32. of the built-in commands.
  33.  
  34.     As of v2.21, this PPE was written in PPL 3.10 for PCBoard 15.21+ only.
  35.  
  36.  
  37. +-----------------------------------------------------------------------------+
  38. | 2. Packaging                                                                |
  39. +-----------------------------------------------------------------------------+
  40.     Your zip file should contain the following files:
  41.  
  42.         EFLAG    DOC   EFLAG Documentation (you are reading it now)
  43.         EFLAG    HLP   EFLAG help screen
  44.         EFLAG    PPE   The actual PPE
  45.         EXTERNAL ZIP   Sample front-end ppe's to use
  46.         HISTORY  DOC   History/revision document
  47.         INSTALL  BAT   Installation batch file
  48.         PR1CFG         Config file for Prompt #1 (language aware)
  49.         PR2CFG         Config file for Prompt #2 (language aware)
  50.         YESNOCFG       Config file for yes/no prompt (language aware)
  51.         _EFLAG   CFG   Optional EFLAG config file (formerly main config)
  52.         OTHERDJP DOC   Other stuff I've written.
  53.         FILE_ID  DIZ   File (zip) description.
  54.         PWA      NFO   PWA info file.
  55.         TSP      NFO   My bbs ad.
  56.  
  57.     If any of these files are missing, be warned that you may have a copy
  58. that has been tampered with.  If you have any extra files, they are
  59. extraneous and unnecessary.
  60.  
  61.     Typically, my bbs ad may not be there, which is not a problem.  However,
  62. the idiots who contribute this to the fidonet backbone (usually originating
  63. from the Clipper Workshop BBS) edit the FILE_ID.DIZ, remove PWA.NFO and
  64. OTHERDJP.DOC, and insert their own bbs ad which is bigger than most ppe's.
  65. Just be aware, since who knows what other stupidities they may pull.
  66.  
  67.  
  68. +-----------------------------------------------------------------------------+
  69. | 3. Installation                                                             |
  70. +-----------------------------------------------------------------------------+
  71.     Simply unzip the original zip file into its own directory and run the
  72. INSTALL.BAT file.  It will automatically tell you the syntax needed to install
  73. EFLAG.  For manual installation, run MKPCBTXT to edit your PCBTEXT file, and
  74. have Prompt #549 point to this ppe with parameters as described below:
  75.  
  76.         !C:\PPE\EFLAG\EFLAG.PPE @X4F 79 yes no 1 @X0F*
  77.  
  78.         Param 1: Lightbar color when highlighting a file
  79.         Param 2: Length (width) of lightbar
  80.         Param 3: Use hotkeys, "yes" or "no"
  81.         Param 4: Use spacebar to highlight a file, "yes" or "no"
  82.         Param 5: Delay time (in clock ticks) between keyboard polls
  83.         Param 6: Color and character for tagged files to be flagged
  84.  
  85.     If you are upgrading from EFLAG v1.0, you must REINSTALL the entire thing
  86. because EFLAG v2.0 has been completely redone and everything is different.
  87.  
  88.     If you are upgrading from v2.2, it is highly suggested that you use the
  89. parameter method of installing EFLAG instead of using the old configuration
  90. file (EFLAG.CFG).  Using the parameters speeds up initial loading and removes
  91. the need for EFLAG.CFG.  You may still use the config file, but you will need
  92. to update it with the correct options.  Refer to "_EFLAG.CFG" for an example.
  93.  
  94.  
  95. +-----------------------------------------------------------------------------+
  96. | 4. Configuration                                                            |
  97. +-----------------------------------------------------------------------------+
  98.     There are two configuration files, all of which are optional.  Default
  99. values will be used in the lack of presence of these configuration files, but
  100. the colours will most likely clash with your boards colour scheme. :)  The
  101. configuration files are as follows:
  102.  
  103.         PR1CFG : Configure the look, feel, and commands for Prompt #1.
  104.         PR2CFG : Configure the look, feel, and commands for Prompt #2.
  105.  
  106.     Both config files are well-documented inside and should be fairly straight
  107. forward.  None of them are heinously long or complex, unless you choose it to
  108. be. :)
  109.  
  110.     In v2.2, a new configuration file, "YESNO.CFG" is added.  This is used
  111. to ask the user if they are sure they want to display the file listing in
  112. nonstop mode.  This feature was added because some users may accidentally
  113. select nonstop mode and do not realize ctrl-k/x aborts the humongous file
  114. listing. :)  If you do not want this feature enabled, simply delete (or
  115. rename) this config file.
  116.  
  117.     ** NOTE! **  v2.21 and up requires PCBoard v15.21 or higher, not 15.2!
  118.  
  119.     In v2.21, the need for EFLAG.CFG has been removed.  See the previous
  120. section (Installation) for details.
  121.  
  122.  
  123. +-----------------------------------------------------------------------------+
  124. | 5. General Notes                                                            |
  125. +-----------------------------------------------------------------------------+
  126.     After v1.0 of EFLAG, which was released back in August 1994, I made some
  127. minor changes/additions/modifications.  Some were minor "bug" fixes, which
  128. were mostly small details in packaging, and did not affect the actual usage of
  129. EFLAG.  A few new features were added as well to make EFLAG even more useful.
  130.  
  131.     However, since that time, PPL 3.0 and PCBoard 15.2 was released and the
  132. continuation of writing more sloppy code in PPL 2.0 seemed moot.  Hence, after
  133. an extremely busy few months dealing with many many things at once, EFLAG 2.0
  134. was completely rewritten in PPL 3.0 and reincarnated.
  135.  
  136.    If you would like your prompts, pathnames, et. al. hard-coded into the
  137. program for fastest execution speed possible (thus removing the need for all
  138. the config files), feel free to let me know.  I will need a copy of all the
  139. config files.  See below on how to contact me.
  140.  
  141.  
  142. +-----------------------------------------------------------------------------+
  143. | 6. Supporting PPE's                                                         |
  144. +-----------------------------------------------------------------------------+
  145.     EFLAG has been personally tested by me <g> to work with the following PPE's
  146. fully with no problem:
  147.  
  148.         o  PWA FileView v2.5
  149.         o  SCuM-NuKeR v1.0/1.1
  150.         o  BlackCat's File Viewer v1.0, v2.0, v2.1, v2.2
  151.         o  BlackCat's Nuker v0.81b, v0.82b
  152.  
  153. Included is EXTERNAL.ZIP which includes some front-end ppe's for usage with
  154. EFLAG to allow EFLAG to execute some the above ppe's seamlessly.  Take a look
  155. inside there for examples, instructions, and details.  If you have a particu-
  156. lar PPE that you wish to interface with EFLAG, feel free to drop me a note if
  157. you need help.
  158.  
  159.  
  160. +-----------------------------------------------------------------------------+
  161. | 7. Last Words                                                               |
  162. +-----------------------------------------------------------------------------+
  163.     if you need to reach me for some reason, you can send internet email to
  164. "drew@topaz.com", or leave me a message on Attitude Net.
  165.  
  166. Peace,
  167. --Drew
  168.